
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>start-instance</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>start-instance</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="start-domain.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="start-local-instance.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="start-instance-1"></a><a id="GSRFM00236"></a><a id="start-instance"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_start_instance">start-instance</h2>
<div class="sectionbody">
<div class="paragraph">
<p>starts a \{product---name} instance</p>
</div>
<div id="sthref2133" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] start-instance [--help]
[--debug={false|true}] [--sync={normal|full|none}]
instance-name</code></pre>
</div>
</div>
<div id="sthref2134" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>start-instance</code> subcommand starts a \{product---name} instance.
This subcommand requires the Distributed Component Object Model (DCOM)
remote protocol or secure shell (SSH) to be configured on the machine
where the domain administration server (DAS) is running and on the
machine where the instance resides.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>DCOM or SSH is not required if the instance resides on a node of type
<code>CONFIG</code> that represents the local host. A node of type <code>CONFIG</code> is not
enabled for remote communication over DCOM or SSH.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>You may run this subcommand from any machine that can contact the DAS.</p>
</div>
<div class="paragraph">
<p>The subcommand can start any \{product---name} instance, regardless of
how the instance was created. For example, this subcommand can start an
instance that was created by using the
<a href="create-local-instance.html#create-local-instance-1"><code>create-local-instance</code>(1)</a>
subcommand.</p>
</div>
<div class="paragraph">
<p>This command is supported in remote mode only.</p>
</div>
<div id="sthref2135" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--debug</code></dt>
<dd>
<p>Specifies whether the instance is started with
Java Platform Debugger Architecture (JPDA)
debugging enabled.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The instance is started with JPDA debugging enabled and the port
number for JPDA debugging is displayed.</p>
</dd>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>The instance is started with JPDA debugging disabled (default).</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--sync</code></dt>
<dd>
<p>The type of synchronization between the DAS and the instance&#8217;s files
when the instance is started.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>none</code></dt>
<dd>
<p>The DAS does not synchronize the instance&#8217;s files with any changes.
This type of synchronization minimizes the time that is required to
start the instance.</p>
</dd>
<dt class="hdlist1"><code>normal</code></dt>
<dd>
<p>The DAS synchronizes the instance with changes since the last
synchronization as follows:<br></p>
<div class="ulist">
<ul>
<li>
<p>For the <code>config</code> directory, the DAS synchronizes the instance with
all changes.</p>
</li>
<li>
<p>For the <code>applications</code> directory and <code>docroot</code> directory, only a
change to a top-level subdirectory causes the DAS to synchronize all
files under that subdirectory.<br>
If a file below a top level subdirectory is changed without a change
to a file in the top level subdirectory, full synchronization is
required. In normal operation, files below the top level
subdirectories of these directories are not changed. If an
application is deployed and undeployed, full synchronization is not
necessary to update the instance with the change.<br>
This value is the default.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1"><code>full</code></dt>
<dd>
<p>The DAS synchronizes the instance with all of the instance&#8217;s files,
regardless of whether the files have changed since the last
synchronization. This type of synchronization might delay the
startup of the instance while the DAS updates all files in the
instance&#8217;s directories.</p>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<div id="sthref2136" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">instance-name</dt>
<dd>
<p>The name of the \{product---name} instance to start.</p>
</dd>
</dl>
</div>
<div id="sthref2137" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM761"></a><a id="sthref2138"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Starting a \{product---name} Instance</p>
</div>
<div class="paragraph">
<p>This example starts the \{product---name} instance <code>pmdsa1</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; start-instance pmdsa1
Waiting for the server to start ..............................
Successfully started the instance: pmdsa1
instance Location: /export/glassfish3/glassfish/nodes/localhost/pmdsa1
Log File: /export/glassfish3/glassfish/nodes/localhost/pmdsa1/logs/server.log
Admin Port: 24848
Command start-local-instance executed successfully.
The instance, pmdsa1, was started on host localhost

Command start-instance executed successfully.</code></pre>
</div>
</div>
<div class="paragraph">
<p><a id="GSRFM762"></a><a id="sthref2139"></a></p>
</div>
<div class="paragraph">
<p>Example 2   Starting a \{product---name} Instance With JPDA Debugging
Enabled</p>
</div>
<div class="paragraph">
<p>This example starts the \{product---name} instance <code>ymlsa1</code> with JPDA
debugging enabled.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; start-instance --debug=true ymlsa1
Waiting for the server to start ...............................
Successfully started the instance: ymlsa1
instance Location: /export/glassfish3/glassfish/nodes/localhost/ymlsa1
Log File: /export/glassfish3/glassfish/nodes/localhost/ymlsa1/logs/server.log
Admin Port: 24849
Debugging is enabled. The debugging port is: 29010
Command start-local-instance executed successfully.
The instance, ymlsa1, was started on host localhost

Command start-instance executed successfully.</code></pre>
</div>
</div>
<div id="sthref2140" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref2141" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="create-instance.html#create-instance-1"><code>create-instance</code>(1)</a>,
<a href="create-local-instance.html#create-local-instance-1"><code>create-local-instance</code>(1)</a>,
<a href="delete-instance.html#delete-instance-1"><code>delete-instance</code>(1)</a>,
<a href="delete-local-instance.html#delete-local-instance-1"><code>delete-local-instance</code>(1)</a>,
<a href="setup-ssh.html#setup-ssh-1"><code>setup-ssh</code>(1)</a>,
<a href="start-domain.html#start-domain-1"><code>start-domain</code>(1)</a>,
<a href="start-local-instance.html#start-local-instance-1"><code>start-local-instance</code>(1)</a>,
<a href="stop-domain.html#stop-domain-1"><code>stop-domain</code>(1)</a>,
<a href="stop-instance.html#stop-instance-1"><code>stop-instance</code>(1)</a>,
<a href="stop-local-instance.html#stop-local-instance-1"><code>stop-local-instance</code>(1)</a>,
<a href="validate-dcom.html#validate-dcom-1"><code>validate-dcom</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="start-domain.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="start-local-instance.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
